home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 18 / CU Amiga Magazine's Super CD-ROM 18 (1997)(EMAP Images)(GB)[!][issue 1998-01].iso / CUCD / Online / hsc / docs-source / project / prjfile.hsc < prev   
Encoding:
Text File  |  1997-06-15  |  1.9 KB  |  50 lines
  1. <WEBPAGE chapter="hsc - Project Management - " title="The Project File"
  2.     BACK="index.html"
  3.     PREV="index.html"
  4.     NEXT="hscpitt.html">
  5.  
  6. <H2>Introduction</H2>
  7.  
  8. Optionally, <hsc> can maintain a project-file, where it stores
  9. some information about the document it currently processes.
  10. This includes
  11. <UL>
  12. <LI>name of the html-object created
  13. <LI>name of the main hsc-source used
  14. <LI>names of all files include (both via user arguments or <ln_include>)
  15. <LI>local IDs defined in this document (using <TG>A NAME="id"</TG>)
  16. </UL>
  17.  
  18. This enables <hsc> to check references to local IDs in other documents 
  19. of your project. Additionally, you can now use <ln_hscdepp> to maintain 
  20. the dependencies between hsc-source and html-object and update your
  21. <makefile>.
  22.  
  23. <H2>How To Get Started With It</H2>
  24.  
  25. <P>To make <hsc> keep the project-file up-to-date, you have to use the
  26. CLI-option <CODE>PRJFILE=<FILE>projec_file</FILE></CODE>. It doesn't
  27. matter how you name your project-file, however I suggest to call it
  28. <FILE>hsc.project</FILE>; this is the default-name <hscdepp> asumes.</P>
  29.  
  30. <P>But it's very important to use the <EM>same</EM> name for the
  31. project-file every time you invoke <hsc>. Otherwise, <hsc> and <hscdepp>
  32. won't be able to find all required information and will launch warnings
  33. or create incomplete dependencies.</P>
  34.  
  35. For example,you can invoke <hsc> using
  36. <PRE>
  37.    hsc FROM=hugo.hsc TO=html: PRJFILE=hsc.project
  38. </PRE>
  39.  
  40. <P>If the project-file does not yet exist, <hsc> displays a warning.
  41. You can ignore this, and the project-file will be created after
  42. the (successful) creation of the html-object. The next time you 
  43. start <hsc> passing the same project-file, no warning will appear.</P>
  44.  
  45. <P>Until all documents have been processed (and added therefor been
  46. added to the project-file) by <hsc> at least once, there will also
  47. be some occurrences of <ln_msg id="51"> you can ignore, too.</P>
  48.  
  49. </WEBPAGE>
  50.